Sourced from starlette-exporter's releases.

v0.17.1

Add FutureWarnings for group_paths and filter_unhandled_paths indicating that the default values will change next release (see #79 )

v0.17.0

Changes for v0.17.0:

• include headers in app scope when matching request path #76 @​evstratbg
• callback functions used to populate labels can now be async #70 @​YiuRULE

Potentially impactful changes:

• the status code reported for client disconnections will now be 499 instead of 500 #77 @​Alexander-N
  • note: some users may notice a new status_code=499 timeseries if a client disconnects before response is written (previously this would be erroneously reported as a 500 status).

Optionally skip methods

v0.16.0

skip_methods option

This releases adds the skip_methods option, which allows you to avoid recording metrics for any requests with the specified methods. Use this if you do not want certain types of requests (e.g. OPTIONS) to appear in your metrics. The argument should be a list of strings corresponding to method names.

Usage:

app.add_middleware(
  PrometheusMiddleware,
  app_name="hello_world",
  skip_methods=['OPTIONS']
)

Credit to @​adinsoon for this new feature.

Bug fixes

Fix for Module "starlette_exporter" does not explicitly export attribute "PrometheusMiddleware" (#63) @​poofeg

README fixes: fixed references to the handle_metrics function in example (@​elatomo ), and fixed the exemplars example (@​camerondavison)

update type hint for buckets param

This small release updates the type hint for the buckets param from List to Sequence to match the type hint in the Prometheus client library. Credit to @​sbrandtb (#59)

Exemplar support

Adds exemplar support for the request counter and request latency histograms. This is intended to be used with tracing (e.g. OpenTelemetry).

You must supply your own callback function that returns a trace id to be used as the exemplar. PRs welcome with an example, or a simple OpenTelemetry-based helper function.

Example:

</tr></table> 

... (truncated)

• 7b011cd add warning for changing defaults
• dcbd33a update setup.py for v0.17.0
• a194f99 Merge pull request #76 from evstratbg/patch-1
• 91e7ea2 rollback tests
• c1f9315 delete unused import
• 6863016 Merge pull request #77 from Alexander-N/client-disconnect
• 6ddd95f Use status code 499 for requests where the client closed the connection
• 6ab98a9 delete main
• ef31e25 make exact tests available to run via UI, added conftest
• d2bc81f check BaseRoute inheritance and validate routes existance
• Additional commits viewable in compare view

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)